<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="Runner,reflexunit.framework.Runner,result,create,run" name="keywords">
<title>reflexunit.framework.Runner</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'Runner - API Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?reflexunit/framework/Runner.html&amp;reflexunit/framework/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Runner</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Runner"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">reflexunit.framework</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Runner</td>
</tr>
</table>
<p></p>
  This class is responsible for the high-level management of test execution.
  That includes the following actions:
  <ol>
    <li>Convert a <code>TestSuite</code>, if provided, into a <code>Recipe</code> of testable methods</li>
    <li>Execute each of those methods and store their outcome in a <code>Result</code> object</li>
    <li>Inform a given set of <code>IResultViewer</code> objects of its progress by way of a <code>RunNotifier</code> method</li>
  </ol>
  
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="display/IResultViewer.html" target="">reflexunit.framework.display.IResultViewer</a>
<br>
<a href="models/Recipe.html" target="">reflexunit.framework.models.Recipe</a>
<br>
<a href="../framework/RunNotifier.html" target="">reflexunit.framework.RunNotifier</a>
<br>
<a href="../framework/TestSuite.html" target="">reflexunit.framework.TestSuite</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#result">result</a> : <a href="models/Result.html">Result</a>
<div class="summaryTableDescription">[read-only]</div>
</td><td class="summaryTableOwnerCol">Runner</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#Runner()">Runner</a>(testSuiteOrRecipeIn:*)</div>
<div class="summaryTableDescription">
   Construcor.</div>
</td><td class="summaryTableOwnerCol">Runner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#create()">create</a>(testSuiteOrRecipeIn:*, resultViewers:Array, runNotifier:<a href="RunNotifier.html">RunNotifier</a> = null, resultIn:<a href="models/Result.html">Result</a> = null):<a href="models/Result.html">Result</a>
</div>
<div class="summaryTableDescription">[static]
   Convenience method for creating and executing a <code>Runner</code> instance.</div>
</td><td class="summaryTableOwnerCol">Runner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#run()">run</a>(resultViewers:Array, runNotifier:<a href="RunNotifier.html">RunNotifier</a> = null, resultIn:<a href="models/Result.html">Result</a> = null):<a href="models/Result.html">Result</a>
</div>
<div class="summaryTableDescription">
   Executes the current test <code>Recipe</code> and returns a <code>Result</code> object.</div>
</td><td class="summaryTableOwnerCol">Runner</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="result"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">result</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>result:<a href="models/Result.html">Result</a></code>&nbsp;&nbsp;[read-only]<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get result():<a href="models/Result.html">Result</a></code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="Runner()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">Runner</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function Runner(testSuiteOrRecipeIn:*)</code><p>
   Construcor.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">testSuiteOrRecipeIn</span>:*</code> &mdash; TestSuite or custom/pre-built Recipe defining all testable methods to be executed
   
   </td>
</tr>
</table>
<br>
<span class="label">Throws</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code></code> &mdash; if incoming testSuiteOrRecipeIn is neither a TestSuite nor a Recipe
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="create()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">create</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function create(testSuiteOrRecipeIn:*, resultViewers:Array, runNotifier:<a href="RunNotifier.html">RunNotifier</a> = null, resultIn:<a href="models/Result.html">Result</a> = null):<a href="models/Result.html">Result</a></code><p>
   Convenience method for creating and executing a <code>Runner</code> instance.
   This method will automatically run the newly created <code>Runner</code> and return its <code>Result</code> object.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">testSuiteOrRecipeIn</span>:*</code> &mdash; TestSuite or Recipe containing tests to be run
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">resultViewers</span>:Array</code> &mdash; Array containing IResultViewer instances to be notified of test progress
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">runNotifier</span>:<a href="RunNotifier.html">RunNotifier</a></code> (default = <code>null</code>)<code></code> &mdash; (Optional) RunNotifier to use if caller wishes to be informed of progress
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">resultIn</span>:<a href="models/Result.html">Result</a></code> (default = <code>null</code>)<code></code> &mdash; (Optional) Result to store progress in; if no value is supplied a new Result will be created
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="models/Result.html">Result</a></code> &mdash; 
                        Result object in which test outcomes will be stored
   
   
                        
                     </td>
</tr>
</table>
<br>
<span class="label">Throws</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code></code> &mdash; if resultsViewer contains non-IResultViewer object(s) 
   </td>
</tr>
</table>
</div>
<a name="run()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">run</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function run(resultViewers:Array, runNotifier:<a href="RunNotifier.html">RunNotifier</a> = null, resultIn:<a href="models/Result.html">Result</a> = null):<a href="models/Result.html">Result</a></code><p>
   Executes the current test <code>Recipe</code> and returns a <code>Result</code> object.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">resultViewers</span>:Array</code> &mdash; Array containing IResultViewer instances to be notified of test progress
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">runNotifier</span>:<a href="RunNotifier.html">RunNotifier</a></code> (default = <code>null</code>)<code></code> &mdash; (Optional) RunNotifier to use if caller wishes to be informed of progress
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">resultIn</span>:<a href="models/Result.html">Result</a></code> (default = <code>null</code>)<code></code> &mdash; (Optional) Result to store progress in; if no value is supplied a new Result will be created
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="models/Result.html">Result</a></code> &mdash; 
                        Result object in which test outcomes will be stored
   
   
                        
                     </td>
</tr>
</table>
<br>
<span class="label">Throws</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code></code> &mdash; if resultsViewer contains non-IResultViewer object(s) 
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
